home *** CD-ROM | disk | FTP | other *** search
/ Aminet 30 / Aminet 30 (1999)(Schatztruhe)[!][Apr 1999].iso / Aminet / util / boot / alm32b.lha / ALM / ALM.english.doc < prev    next >
Text File  |  1999-01-03  |  14KB  |  479 lines
  1. ----------------------------------------------------------------
  2. ALM Version 3.2 --- Alm.Editor 3.2 & ShowAlm 3.2
  3. ----------------------------------------------------------------
  4.  
  5. ENGLISH INSTRUCTIONS.                                                                
  6. ----------------------------------------------------
  7.  
  8. Do you have a problem remembering peoples birthdays? And how many
  9. years they celebrate. I had, and that's why I made these two programs.
  10. Now, I have used ALM in over 6 years, and I never miss a birthday
  11. or anything else imortant any more!!!
  12.  
  13. ----------------------------------------------------
  14.  
  15. ALM is a program package, including ALM.Editor and ShowALM.
  16. These programs may be distributed freely, but can not be sold for
  17. profit.
  18.  
  19. ALM needs an Amiga Classic - AmigaDos 2.0 or better.
  20.  
  21. The whole thing works as a kind of calendar. You type in important
  22. days in ALM.Editor and are then warned of future bithdays etc. by
  23. ShowALM. Put ShowALM in your startup-sequence or user-startup
  24.  
  25. With ALM.Editor you edit the file S:ALM.data
  26.  
  27. ShowALM is a Shell command that loads ALM.data and displays the
  28. next important day(s) in the shell window. You can also search for
  29. a specific day or a word, for example determin how many days there
  30. is to christmas day, and what day of the week that is etc.
  31.  
  32.  
  33.  
  34. ALM Editor V3.2
  35. ----------------
  36.  
  37. You edit as said the file S:ALM.data. This file is not formatted as a
  38. standard ASCII file, but is devided into all the days of ONE year. The
  39. date for the day you are editing is shown in the information bar, top
  40. left in the window. (white on black with the standard colours). It can
  41. for example show 1998-Aug-02 or something like that... You change day
  42. by clicking on this date. If you only want to change the day, then just
  43. click on the day in the date. There is two other buttons in right of the
  44. date. "<-Prev" and "Next->". You can click on these to jump to the next
  45. day containing text (If you not have changed the search word. But more
  46. about this later.)
  47.  
  48. Note:  Its not possible to edit more than a screen full of text on
  49.        each day. It's also not possible to have lines longer than
  50.        the windows width.
  51.  
  52. Watch and Edit mode.
  53. --------------------
  54.  
  55. There is two different modes in ALM.Editor: "View" and "Edit".
  56.  
  57. In edit mode you edit the text, and in View (or Watch) mode, you
  58. can see how the text will look when displayed by ShowALM. This is
  59. necessary as you can type in birth years in the text, and then
  60. get the age of the person in question from ShowALM.
  61.  
  62. If you for examlpe write (in edit mode):
  63.  
  64. ----------------
  65. Andrew is *1973 years old today!! Happy Birthday!!!!¶
  67. ----------------
  68.  
  69. (The ¶-signs is end-of-line markers, nothing to care about)
  70.  
  71. Then this will look like this in View mode: (If it now is 1998)
  72.  
  73. ----------------
  74. Andrew is 25 years old today!! Happy Birthday!!!
  75.  
  76. ----------------
  77.  
  78. In View mode, ALM basically takes todays year minus the value typed
  79. in after the star (*). In this case: 1998-1973 = 25.
  80.  
  81. ALM also removes the negative-sign if there is one. You can say that
  82. ALM shows the difference between the year and the value after *.
  83.  
  84. You can therefor for examle write (in the same day as the example
  85. above):
  86. -----------------
  87. In *2023 years, I will be 50 years old!¶
  88.  
  89. -----------------
  90.  
  91. Which will show:
  92.  
  93. -----------------
  94. In 25 years, I will be 50 years old!
  95.  
  96. -----------------
  97.  
  98. As 1998-2023 is 25
  99.  
  100.  
  101. Note: The value after the star MUST be 4 digits!
  102.  
  103.  
  104.  
  105.  
  106. Temporary Notes
  107. ---------------
  108.  
  109. Temporary notes was a new feature of ALM2.2, made on request from
  110. a faithful user of ALM: Fredrik Sörensson.
  111.  
  112. The whole thing is that you have two types of notes. Temporary and
  113. resident ones. Resident notes is the kind as in the examples above:
  114. Birthdays etc. Temporary notes is the kind like: Go to the dentist,
  115. Math test etc. Notes you only have use for at one time, not several
  116. years. These temporary notes is preceded by a "<"-sign.
  117.  
  118. Example:
  119. --------------
  120. I am today *1973 years old.¶
  122. <Clean my room¶
  123. <or something....¶
  124. --------------
  125.  
  126. These "<" is used so that ALM.Editor easily can delete the temporary
  127. notes and leave the resident ones without deleting them. The "<" must
  128. be written in the very beginning of the line, else ALM will not
  129. recognise it as a temporary note. Then, some time later when the days
  130. with the temporary notes has passed, you don't want these temporary
  131. notes to come back next year. Therefor, there is a date layed in
  132. ALM.data that indicates when you last deleted your temporary notes.
  133. You do this with the menu "Edit:Clear past temp.notes". This command
  134. starts to search for temporary notes from the latest delete date.
  135. If any temporary notes was found, ALM will display the day in the
  136. window and ask if you want to delete the temporary notes on this
  137. day etc...
  138.  
  139. You can also let ShowALM to automatically remove old temp notes by
  140. using the "AutoRem" option. See futher below.
  141.  
  142. -------------------------------------------------------------------
  143. ALM EDITOR 3.2, menu by menu.
  144. -------------------------------------------------------------------
  145.  
  146. The FILE menu:
  147. --------------
  148.  
  149. New:
  150.  
  151. All the data is deleted.
  152.  
  153.  
  154. Load:
  155.  
  156. With this function you can load an ALM.data file. This is the file you
  157. are editing. As default you should use S:ALM.data. This file is loaded
  158. automaically every time you start ALM.Editor, so you probably don't
  159. need to use this function much.
  160.  
  161.  
  162. Save:
  163.  
  164. Save the ALM.data file you have in memory.
  165.  
  166.  
  167. Load ASCII to day:
  168.  
  169. Loads an ascii text and overwrites the day with this file. As you only
  170. can edit a window full of text, this is olny what will be loaded.
  171.  
  172. If the text contains any ¶-signs, then these will be replaced with
  173. #-signs, as ALM uses ¶-signs as end-of-line-signs
  174.  
  175.  
  176. Save day to ASCII:
  177.  
  178. Saves the day to an ascii file.
  179.  
  180.  
  181. Exit: (You can also press ESC)
  182.  
  183. Ends the program. If you not have saved the current ALM.data file,
  184. any changes will be lost.
  185.  
  186.  
  187. Save & Exit:
  188.  
  189. Saves the current ALM.data file and then ends the program.
  190.  
  191.  
  192. The GO menu:
  193. ------------
  194.  
  195. Next: (or F2, or the button on the information bar)
  196.  
  197. Looks for the next note containing the search-word. (See below)
  198.  
  199.  
  200. Prev: (or F1, or the button on the information bar)
  201.  
  202. Looks for the previous note containing the search-word. (See below)
  203.  
  204.  
  205. Search-word: (or F3)
  206.  
  207. Change the search-word. Current search-word is allways shown
  208. in the information bar. It is also displayed in the GO menu
  209. under "Search-word".
  210.  
  211. You can choose:
  212.  
  213. *, nothing, or a text string.
  214.  
  215. If you choose *, (the default search-word), the next day is
  216. searched for, containing any text at all. (The next note,
  217. you can say)
  218.  
  219. If you choose "nothing" (just press return), the next day is
  220. searched for, even if it not is used.
  221.  
  222. If you type in a text string, for example: "Andrew is", the next
  223. day containing this text is searched for.
  224.  
  225.  
  226.  
  227. The EDIT menu
  228. -------------
  229.  
  230. Clear day:
  231.  
  232. Yep, exactly what you think: Delete the note for this day.
  233.  
  234. When you have done this, it's not possible to find the day
  235. with * as the search-word.
  236.  
  237.  
  238. Edit mode:
  239.  
  240. Change to edit mode (see above)
  241.  
  242. You can also press any key (except F1 etc) to enter edit mode.
  243. So, you can just begin to type in your message to enter the
  244. edit mode.
  245.  
  246. You can also click with left mous button somewhere in the text.
  247. Then you are entering edit mode, and the cursor is placed where
  248. you clicked.
  249.  
  250.  
  251. Watch mode: (F5)
  252.  
  253. Enters the watch (view)-mode. Look above in this doc.
  254.  
  255.  
  256. Delete temporary notes:
  257.  
  258. Deletes all lines preceded by a "<"-sign in the currend day. The
  259. "<" must be put in the very beginning of the line. (See above in
  260. this doc). If the day after deleting the temporary notes only consists
  261. of spaces and EOL-signs, then the whole day will be deleted.
  262.  
  263. Tip:
  264. If you want to delete some lines that not are temporary, you can
  265. simply put a "<" in front of the line, and then choose this function.
  266.  
  267.  
  268. Clear past temp. notes:
  269.  
  270. Every time this function is used, todays date is saved to the ALM.data file.
  271. So, first, it looks in ALM.data to see when you last deleted your temp.
  272. notes. Then all days containing temp.notes are scanned for, and the
  273. previous function (Delete temp. notes) is used on these days. After that,
  274. todays date is saved to ALM.data, so that ALM.editor will know when
  275. you deleted your temp. notes last time.
  276.  
  277.  
  278. Copy day to buffer:
  279.  
  280. Copy the current note to the copy buffer.
  281.  
  282.  
  283. Copy buffer to day:
  284.  
  285. (Paste). Copies the buffer to the current day. If the buffer is empty,
  286. then the day will be cleared.
  287.  
  288.  
  289. The ABOUT menu:
  290. ---------------
  291.  
  292. In this menu you can find some information about ALM.Editor, ShowALM,
  293. ALM.data and Temporary Notes.
  294.  
  295.  
  296.  
  297. --------------------------------------------
  298.  
  299. The shell command SHOWALM 3.2:
  300.  
  301. --------------------------------------------
  302.  
  303. This is the program that warns you of comming birthdays etc. You
  304. should put it in your startup-sequence or user-startup. If you
  305. don't want to edit these files, you can put the file "ALM.show"
  306. in your WBStartup drawer. It's a shell script that is executed
  307. by iconX. But don't forget to put ShowALM in C: first.
  308.  
  309. The best thing to do is probably to put showalm first in user-startup
  310.  
  311.  
  312.  
  313. There is many different options.
  314.  
  315.  
  316. Try:
  317.  
  318. ShowALM ?
  319.  
  320. , and you will see them.
  321.  
  322.  
  323. But you probably don't want to do that now, so I write them here:
  324.  
  325. Usage: ShowALM [Next n] [Find "word" / all / all*] [Svenska]
  326.        [From name] [Echo "string"] [Echo* "string"]
  327.        [Date YYYYMMDD / MMDD] [SP] [NL] [NeverMiss] [Wait [n]] [AutoRem]
  328.  
  329.  
  330. Next <n> :
  331. ----------
  332. <n> is the nuber of days you want to see, for ex:
  333.  
  334. Showalm next 3  ;shows the next 3 days containing text. (The 3 next
  335. notes) (Like searching with * in the editor 3 times.)
  336.  
  337. Find "word" :
  338. -------------
  339. The equivalent of changing the search-word in ALM.Editor
  340. If the Find option not is stated, you can say that the search-word
  341. is *
  342.  
  343. The search allways begins "today". Even with Find all and find all*
  344. (See below)
  345.  
  346. If you for ex. write:
  347. showalm next 2 find "Andrew is", then the next two days containing this
  348. text is shown. If there only is one day containing this, then the
  349. second search will display the same day, but one year from now..
  350. (365 days more, or 366 if it's a leap-year.)
  351.  
  352.  
  353. Find all :
  354. ----------
  355. shows all days, even the ones without text.
  356.  
  357. Find all* :
  358. -----------
  359. Searches for all days (like "find all") but displays only the once
  360. containing text. For example:
  361.  
  362. Showalm next 3 find all*       ;If there is any note for today,
  363. tomorrow or the day after tomorrow, then this/these will be shown.
  364.  
  365. From "name" :
  366. -------------
  367. Load ALM.data from the file "name". If you don't use this, then
  368. showalm loads S:ALM.data.
  369.  
  370. Echo "string" :
  371. ---------------
  372. "string" is written as a heading, for ex:
  373. ShowALM next 7 find all* echo "My ALManac, one week ahead"
  374.  
  375. Echo* "string" :
  376. ----------------
  377. The string is printed if the option FIND don't find anything, for
  378. example:
  379. Showalm next 5 find all* echo* "Nothing to worry about!"
  380.  
  381. Svenska :
  382. ---------
  383. All text will be in swedish.
  384.  
  385. Date YyyyMmDd or Date MmDd :
  386. ----------------------------
  387. Begin the search from specified date. You can never go to 29.Feb
  388. regardless if it's a leap-year or not.
  389. Ex:
  390. showalm date 0212 find all     ;Shows february the 12:th
  391. showalm date 20100430 next 2   ;Begins the search April the 30:th
  392. year 2010 and shows the next two notes fom there.
  393.  
  394. SP :
  395. ----
  396. Gives an extra space line between the date line and the note.
  397.  
  398. NL :
  399. ----
  400. The lines (-------------------) marking where a day starts and ends
  401. is not printed.
  402.  
  403. Wait :
  404. ------
  405. The program asks you to press return before it ends, but only if
  406. a note has been shown.
  407.  
  408. Wait 3:
  409. -------
  410. The program asks you to press return before it ends, but only if
  411. a note for a day that comes within 3 days has been shown. So, for
  412. example "wait 0" will only wait if a note for todays date has been
  413. shown.
  414.  
  415. Please note that "wait [n]" only waits ONCE a day (for the same data file)!
  416. Before, you had to press return every time. But if you rebooted the
  417. computer many times in the same day, it was quite irritating to press
  418. return every time. If you have pressed once, you have seen the notes for
  419. today and don't want to be delayed again. Now, you don't have to do
  420. that any longer.
  421.  
  422. NeverMiss :
  423. -----------
  424. If you don't use your computer every day, or maybe if you not are
  425. home for a week, it can happen that you miss some important notes
  426. in ALM. But if you use "NeverMiss", you will not miss anything, as
  427. the notes you should have missed without "Nevermiss" is shown before
  428. the usual notes. ShowAlm asks you to press return before the usual
  429. notes are shown.
  430.  
  431. AutoRem:
  432. --------
  433. ShowALM will automatically remove old temporary notes that not are
  434. needed any longer. So, if you use AutoRem, you won't need to use
  435. ALM.Editor to remove them. AutoRem removes old temp notes about
  436. once a month.
  437.  
  438.  
  439. MULTICOMMANDS :
  440. ---------------
  441. You can perform several searches or caommand sets by putting a "|"
  442. sign between them. This way, you don't have to load ShowALM and
  443. ALM.data many times to get the right result.
  444.  
  445. Ex:
  446. ShowALM next 2 | date 1225 find all     ;Shows the two next notes and
  447. christmas day.
  448.  
  449.  
  450. The options: [Svenska], [NeverMiss], [Wait] and [From name] are global
  451. and has only to be stated once (in one command set).
  452.  
  453.  
  454.  
  455. --------------------------------------------------------------
  456.  
  457. Every time ShowALM shows a day, it also shows how many days it's
  458. left to the day and what day of the week it is.
  459.  
  460. Leap-years are programmed to eternity.
  461.  
  462. --------------------------------------------------------------
  463.  
  464.  
  465.  
  466. If you find any bugs or have any smart ideas for these program,
  467. then send me a letter:
  468.  
  469. boray@alfa.telenordia.se
  470.  
  471. Anders Persson
  472. Mellangårdsvägen 9
  473. S-417 29 Göteborg
  474. SWEDEN
  475.  
  476.  
  477. Kind Regards,
  478. Anders Persson
  479.